2-3 VSCode插件:轻量REST客户端应用场景
为什么选择 REST Client
在开发过程中,接口测试工具的选择取决于具体场景。Postman 作为桌面级工具功能全面,但在某些生产环境中直接安装 Postman 并不便利——比如需要在生产服务器上调试接口时,安装 VS Code 远比安装 Postman 简单得多。
REST Client 是一款 VS Code 插件,它的核心优势在于:不需要在编辑器和独立的 REST 客户端之间来回切换。请求代码和服务端代码在同一个编辑器中完成,工作流更加连贯。
主要特性
| 特性 | 说明 |
|---|---|
| 编辑器内发送请求 | 直接在 .http 或 .rest 文件中编写并发送 HTTP 请求 |
| 响应高亮 | 返回数据自动语法高亮,便于阅读 |
| GraphQL 支持 | 可发送 GraphQL 查询 |
| curl 互转 | 既能执行 curl 命令,也能将请求复制为 curl |
| 代码生成 | 生成多种语言的请求代码片段(Python、Java 等) |
| 环境变量 | 支持文件变量、prompt 变量、.env 文件读取 |
| 历史记录 | 查看并重放历史请求 |
基本使用
创建请求文件
在项目根目录创建 .http 或 .rest 后缀的文件即可开始编写请求:
### GET 请求示例
GET http://localhost:3000/db
http
文件保存后,每个请求上方会出现 Send Request 按钮,点击即可发送并查看响应。
POST 请求
两个请求之间用 ### 分隔。POST 请求需要设置 Content-Type 并附带请求体:
### 写入 POST home 接口
POST http://localhost:3000/home
Content-Type: application/json
{
"message": "from rest client"
}
http
GET 参数查询
GET 参数需要逐行书写,一行一个参数:
### GET 分页参数传递
GET http://localhost:3000/hello?page=2
&size=2
http
变量与环境配置
REST Client 提供多种变量定义方式,适应不同场景:
文件变量
在文件顶部使用 @ 定义变量:
@host = http://localhost:3000
GET {{host}}/db
http
注意:文件变量是全局生效的。如果在文件中多处定义同名变量,后面的定义会覆盖前面的,这在文件较长时容易引发混乱。
Prompt 变量
适合需要输入敏感数据(如密码、Token)的场景,每次发送请求时会弹出输入框:
@apiKey = {{prompt:请输入API名称}}
GET http://localhost:3000/{{apiKey}}
http
读取 .env 文件
REST Client 可以直接读取项目中的 .env 配置文件:
@baseUrl = {{$dotenv base_url}}
GET {{baseUrl}}/hello
http
.env 文件内容:
base_url=http://localhost:3000
text
实用技巧
请求转 curl
在任意请求上右键,选择 Copy Request As cURL 即可复制为 curl 命令,方便在终端中直接执行。
生成代码片段
选中请求后,通过命令面板(Ctrl+Shift+P)搜索 REST Client: Generate Code Snippet,选择目标语言(如 Python 3 HTTP Client),即可生成对应语言的请求代码。这使得在没有 Node.js 环境但有其他语言环境的服务器上也能快速发送请求。
快速定位请求
当 .http 文件中请求较多时,使用快捷键 Ctrl+Shift+O(Windows)或 Cmd+Shift+O(Mac)可以调出符号面板,快速在各个请求和变量之间跳转。
查看历史请求
通过命令面板搜索 REST Client: View Request History,可以查看所有历史请求记录,选中后即可重新发送。
参考资源
- REST Client GitHub - 插件源码与详细文档
↑